/*
* Licensed under the MIT License
* 
* Copyright (c) 2010 Kay Kreuning
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* 
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
* 
* http://code.google.com/p/as3hyvesapi
*/
package nl.hyvesstudio.utils
{
	/**
	 * Utilities for working with URL's.
	 * 
	 * @author Kay Kreuning
	 */
	public class URLUtil
	{
		/**
		 * Decode the <code>parameters</code> object into a <code>String</code> that can be used as the variables of a HTTP GET URL. 
		 * 
		 * @param parameters <code>Object</code> with parameters to decode
		 * @param keyValueSeperator character to put between the key and value of each property
		 * @param pairSeperator character to put between each key value pair
		 * @return <code>String</code> that can be used as the variables of a HTTP GET URL.  
		 */
		public static function decodeToGetVariables(parameters:Object, keyValueSeperator:String = "=", pairSeperator:String = "&"):String {
			var array:Array = new Array();
			
			for (var key:String in parameters)
			{
				array.push(key + keyValueSeperator + encodeURIComponent(parameters[key].toString()));
			}
			
			array.sort();
			
			return array.join(pairSeperator);
		}
	}
}